IconRefToRgn

IconRefToRgn
Header:	Icons.h		Carbon status:	Supported

Converts an IconRef-derived icon into a QuickDraw region.

OSErr IconRefToRgn (
     theRgn, 
    const Rect *iconRect, 
    IconAlignmentType align, 
    IconServicesUsageFlags iconServicesUsageFlags, 
    IconRef theIconRef
);

theRgn: A handle to the requested region. You must call the QuickDraw function NewRegion to allocate memory for the region handle before calling the IconRefToRgn function.
iconRect: A pointer to the rectangle defining the area that Icon Services uses as the bounding box of the region.
align: The value which determines how Icon Services aligns the region within the rectangle. For a description of possible return values, see “Icon Alignment Constants”.
iconServicesUsageFlags: Reserved for future use. Pass the kIconServicesDefaultUsageFlags constant in this parameter.
theIconRef: The IconRef for the icon family to use for drawing the requested region.

function result: A result code.

DISCUSSION

Icon Services uses the rectangle and alignment values to automatically select the icon used to generate the region data.

This function is similar to the Icon Utilities function IconSuiteToRegion.

Icon Services uses the icon’s black-and-white mask to determine the region data, even if you provide a deep mask.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.